Clarify documentation #178
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thank you for your PR, appreciated.(I'd sworn to precede took 4 'e's). Just a little note, are you aware that you have removed one doctest example ? I'll put it back after the merge :) |
|
@jwworth I just forgot and will fix it by hand, but for your info. All you did will be overwritten by our build process, I need to document that as all code related information in the README is generated from docstrings. (so even I do not forget) |
|
@RobertDober makes sense; thanks for the explanation. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Thank you for building and maintaining this project!
I've been reading this documentation trying to fix a bug, and found a code example that could be clearer. I fixed a few typos along the way.
Thanks again!